Download OpenAPI specification:Download
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "plan": "FREE",
- "website_url": "string",
- "repository": "string",
- "logo_url": "string",
- "icon_url": "string",
- "admin_emails": [
- "string"
], - "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}
]
}| name required | string name is case insensitive |
| description | string |
| plan required | string (PlanEnum) Enum: "FREE" "TEAM" "TEAM_YEARLY" "ENTERPRISE" "ENTERPRISE_YEARLY" |
| website_url | string or null |
| repository | string or null |
| logo_url | string or null |
| icon_url | string or null |
| admin_emails | Array of strings or null |
{- "name": "string",
- "description": "string",
- "plan": "FREE",
- "website_url": "string",
- "repository": "string",
- "logo_url": "string",
- "icon_url": "string",
- "admin_emails": [
- "string"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "plan": "FREE",
- "website_url": "string",
- "repository": "string",
- "logo_url": "string",
- "icon_url": "string",
- "admin_emails": [
- "string"
], - "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}| organizationId required | string <uuid> Organization ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "plan": "FREE",
- "website_url": "string",
- "repository": "string",
- "logo_url": "string",
- "icon_url": "string",
- "admin_emails": [
- "string"
], - "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}To edit an organization you must have the admin permission
| organizationId required | string <uuid> Organization ID |
| name required | string name is case insensitive |
| description | string |
| website_url | string or null |
| repository | string or null |
| logo_url | string or null |
| icon_url | string or null |
| admin_emails | Array of strings or null |
{- "name": "string",
- "description": "string",
- "website_url": "string",
- "repository": "string",
- "logo_url": "string",
- "icon_url": "string",
- "admin_emails": [
- "string"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "plan": "FREE",
- "website_url": "string",
- "repository": "string",
- "logo_url": "string",
- "icon_url": "string",
- "admin_emails": [
- "string"
], - "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}List organization api tokens
| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "scope": "ADMIN"
}
]
}Create an organization api token. You can use the generated token to interact in a programmatic way with our API.
| organizationId required | string <uuid> Organization ID |
| name required | string |
| description | string |
| scope required | string (OrganizationApiTokenScope) Value: "ADMIN" |
{- "name": "string",
- "description": "string",
- "scope": "ADMIN"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "token": "string",
- "scope": "ADMIN"
}| organizationId required | string <uuid> Organization ID |
| name | string The name of the repository where to retrieve the branches |
{- "results": [
- {
- "name": "main"
}
]
}| organizationId required | string <uuid> Organization ID |
| name | string The name of the repository to retrieve the branches |
{- "results": [
- {
- "name": "main"
}
]
}| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "string",
- "name": "simple-node-app",
- "default_branch": "master",
- "is_private": true
}
]
}| organizationId required | string <uuid> Organization ID |
| name | string The name of the repository where to retrieve the branches |
{- "results": [
- {
- "name": "main"
}
]
}List organization webhooks
| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "kind": "STANDARD",
- "target_url": "string",
- "target_secret_set": true,
- "description": "string",
- "enabled": true,
- "events": [
- "DEPLOYMENT_STARTED"
], - "project_names_filter": [
- "string"
], - "environment_types_filter": [
- "PRODUCTION"
]
}
]
}Create an organization webhook.
| organizationId required | string <uuid> Organization ID |
| kind required | string (OrganizationWebhookKindEnum) Enum: "STANDARD" "SLACK" Define the type of the webhook. |
| target_url required | string Set the public HTTP or HTTPS endpoint that will receive the specified events.
The target URL must starts with |
| target_secret | string Make sure you receive a payload to sign the Qovery request with your secret.
Qovery will add a HTTP header |
| description | string |
| enabled | boolean Turn on or off your endpoint. |
| events required | Array of strings (OrganizationWebhookEventEnum) Items Enum: "DEPLOYMENT_STARTED" "DEPLOYMENT_CANCELLED" "DEPLOYMENT_FAILURE" "DEPLOYMENT_SUCCESSFUL" |
| project_names_filter | Array of strings Specify the project names you want to filter to.
This webhook will be triggered only if the event is coming from the specified Project IDs.
Notes: 1. Wildcard is accepted E.g. |
| environment_types_filter | Array of strings (EnvironmentModeEnum) Items Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING" Specify the environment modes you want to filter to. This webhook will be triggered only if the event is coming from an environment with the specified mode. |
{- "kind": "STANDARD",
- "target_url": "string",
- "target_secret": "string",
- "description": "string",
- "enabled": true,
- "events": [
- "DEPLOYMENT_STARTED"
], - "project_names_filter": [
- "string"
], - "environment_types_filter": [
- "PRODUCTION"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "kind": "STANDARD",
- "target_url": "string",
- "target_secret_set": true,
- "description": "string",
- "enabled": true,
- "events": [
- "DEPLOYMENT_STARTED"
], - "project_names_filter": [
- "string"
], - "environment_types_filter": [
- "PRODUCTION"
]
}Get an Organization webhook
| organizationId required | string <uuid> Organization ID |
| webhookId required | string <uuid> Webhook ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "kind": "STANDARD",
- "target_url": "string",
- "target_secret_set": true,
- "description": "string",
- "enabled": true,
- "events": [
- "DEPLOYMENT_STARTED"
], - "project_names_filter": [
- "string"
], - "environment_types_filter": [
- "PRODUCTION"
]
}Edit an organization webhook
| organizationId required | string <uuid> Organization ID |
| webhookId required | string <uuid> Webhook ID |
| kind required | string (OrganizationWebhookKindEnum) Enum: "STANDARD" "SLACK" Define the type of the webhook. |
| target_url required | string Set the public HTTP or HTTPS endpoint that will receive the specified events.
The target URL must starts with |
| target_secret | string Make sure you receive a payload to sign the Qovery request with your secret.
Qovery will add a HTTP header |
| description | string |
| enabled | boolean Turn on or off your endpoint. |
| events required | Array of strings (OrganizationWebhookEventEnum) Items Enum: "DEPLOYMENT_STARTED" "DEPLOYMENT_CANCELLED" "DEPLOYMENT_FAILURE" "DEPLOYMENT_SUCCESSFUL" |
| project_names_filter | Array of strings Specify the project names you want to filter to.
This webhook will be triggered only if the event is coming from the specified Project IDs.
Notes: 1. Wildcard is accepted E.g. |
| environment_types_filter | Array of strings (EnvironmentModeEnum) Items Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING" Specify the environment modes you want to filter to. This webhook will be triggered only if the event is coming from an environment with the specified mode. |
{- "kind": "STANDARD",
- "target_url": "string",
- "target_secret": "string",
- "description": "string",
- "enabled": true,
- "events": [
- "DEPLOYMENT_STARTED"
], - "project_names_filter": [
- "string"
], - "environment_types_filter": [
- "PRODUCTION"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "kind": "STANDARD",
- "target_url": "string",
- "target_secret_set": true,
- "description": "string",
- "enabled": true,
- "events": [
- "DEPLOYMENT_STARTED"
], - "project_names_filter": [
- "string"
], - "environment_types_filter": [
- "PRODUCTION"
]
}List organization custom roles
| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "cluster_permissions": [
- {
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string",
- "permission": "VIEWER"
}
], - "project_permissions": [
- {
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "project_name": "string",
- "is_admin": false,
- "permissions": [
- {
- "environment_type": "PRODUCTION",
- "permission": "NO_ACCESS"
}
]
}
]
}
]
}Create an organization custom role
| organizationId required | string <uuid> Organization ID |
| name required | string |
| description | string |
{- "name": "string",
- "description": "string"
}{- "id": "string",
- "name": "string",
- "description": "string",
- "cluster_permissions": [
- {
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string",
- "permission": "VIEWER"
}
], - "project_permissions": [
- {
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "project_name": "string",
- "is_admin": false,
- "permissions": [
- {
- "environment_type": "PRODUCTION",
- "permission": "NO_ACCESS"
}
]
}
]
}Get an organization custom role
| organizationId required | string <uuid> Organization ID |
| customRoleId required | string <uuid> Custom Role ID |
{- "id": "string",
- "name": "string",
- "description": "string",
- "cluster_permissions": [
- {
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string",
- "permission": "VIEWER"
}
], - "project_permissions": [
- {
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "project_name": "string",
- "is_admin": false,
- "permissions": [
- {
- "environment_type": "PRODUCTION",
- "permission": "NO_ACCESS"
}
]
}
]
}Edit an organization custom role
| organizationId required | string <uuid> Organization ID |
| customRoleId required | string <uuid> Custom Role ID |
| name required | string |
| description | string |
required | Array of objects Should contain an entry for every existing cluster |
required | Array of objects Should contain an entry for every existing project |
{- "name": "string",
- "description": "string",
- "cluster_permissions": [
- {
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "permission": "VIEWER"
}
], - "project_permissions": [
- {
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "is_admin": false,
- "permissions": [
- {
- "environment_type": "PRODUCTION",
- "permission": "NO_ACCESS"
}
]
}
]
}{- "id": "string",
- "name": "string",
- "description": "string",
- "cluster_permissions": [
- {
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string",
- "permission": "VIEWER"
}
], - "project_permissions": [
- {
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "project_name": "string",
- "is_admin": false,
- "permissions": [
- {
- "environment_type": "PRODUCTION",
- "permission": "NO_ACCESS"
}
]
}
]
}| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}| organizationId required | string <uuid> Organization ID |
| name required | string name is case insensitive |
| description | string |
{- "name": "string",
- "description": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}Returns a list of project ids, and for each its total numberof services and environments
| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "service_total_number": 0,
- "environment_total_number": 0
}
]
}| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "nickname": "string",
- "email": "user@example.com",
- "last_activity_at": "2019-08-24T14:15:22Z",
- "role": "ADMIN",
- "role_name": "string",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}
]
}Edit an organization member role
| organizationId required | string <uuid> Organization ID |
| user_id required | string specify the git provider user id |
| role_id required | string <uuid> |
{- "user_id": "string",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "role": "ADMIN",
- "invitation_status": "EXPIRED",
- "inviter": "string",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string"
}
]
}| organizationId required | string <uuid> Organization ID |
| email required | string |
| role | string (InviteMemberRoleEnum) Enum: "ADMIN" "DEVELOPER" "OWNER" "VIEWER" deprecated |
| role_id | string <uuid> the target role to attribute to the new member |
{- "email": "string",
- "role": "ADMIN",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "role": "ADMIN",
- "invitation_status": "EXPIRED",
- "inviter": "string",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string"
}| organizationId required | string <uuid> Organization ID |
| inviteId required | string <uuid> Invite ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "role": "ADMIN",
- "invitation_status": "EXPIRED",
- "inviter": "string",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string"
}| organizationId required | string <uuid> Organization ID |
| user_id required | string <uuid> |
{- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}| organizationId required | string <uuid> Organization ID |
{- "plan": "FREE",
- "remaining_trial_day": 0,
- "remaining_credits": {
- "total_in_cents": 30000,
- "total": 300,
- "currency_code": "USD"
}, - "cost": {
- "total_in_cents": 30000,
- "total": 300,
- "currency_code": "USD"
}, - "paid_usage": {
- "max_deployments_per_month": 0,
- "consumed_deployments": 0,
- "monthly_plan_cost": 0,
- "monthly_plan_cost_in_cents": 0,
- "remaining_deployments": 0,
- "deployments_exceeded": true,
- "renewal_at": "2019-08-24T14:15:22Z"
}
}| organizationId required | string <uuid> Organization ID |
| plan | string |
{- "plan": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "plan": "FREE",
- "website_url": "string",
- "repository": "string",
- "logo_url": "string",
- "icon_url": "string",
- "admin_emails": [
- "string"
], - "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}Get your cluster cost range. We are unable to give a precise cost of your infrastructure at the moment. But Qovery guarantees that the cost of your cluster will not exceed the max range.
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "min_cost_in_cents": 15000,
- "min_cost": 150,
- "max_cost_in_cents": 30000,
- "max_cost": 300,
- "currency_code": "USD"
}| organizationId required | string <uuid> Organization ID |
{- "first_name": "Forrest",
- "last_name": "Gump",
- "email": "forrest@gump.com",
- "address": "21 Jenny Street",
- "city": "Greenbow",
- "zip": "36744",
- "state": "Alabama",
- "country_code": "US",
- "company": "string",
- "vat_number": "string"
}| organizationId required | string <uuid> Organization ID |
| first_name required | string |
| last_name required | string |
| email required | string <email> email used for billing, and to receive all invoices by email |
| address required | string |
| city required | string |
| zip required | string |
| state | string only for US |
| country_code required | string ISO code of the country |
| company | string name of the company to bill |
| vat_number | string |
{- "first_name": "Forrest",
- "last_name": "Gump",
- "email": "forrest@gump.com",
- "address": "21 Jenny Street",
- "city": "Greenbow",
- "zip": "36744",
- "state": "Alabama",
- "country_code": "US",
- "company": "string",
- "vat_number": "string"
}{- "first_name": "Forrest",
- "last_name": "Gump",
- "email": "forrest@gump.com",
- "address": "21 Jenny Street",
- "city": "Greenbow",
- "zip": "36744",
- "state": "Alabama",
- "country_code": "US",
- "company": "string",
- "vat_number": "string"
}This endpoint returns a "is_valid" boolean field reflecting the billing status of the organization:
| organizationId required | string <uuid> Organization ID |
{- "is_valid": true,
- "message": "string"
}| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "total_in_cents": 30000,
- "total": 300,
- "currency_code": "USD",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "NOT_PAID"
}
]
}| organizationId required | string <uuid> Organization ID |
| invoiceId required | string <uuid> Invoice ID |
{- "total_in_cents": 30000,
- "total": 300,
- "currency_code": "USD",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "NOT_PAID"
}| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "expiry_month": 6,
- "expiry_year": 2025,
- "last_digit": "7890",
- "is_expired": true
}
]
}| organizationId required | string <uuid> Organization ID |
| number required | string |
| cvv required | string |
| expiry_month required | integer |
| expiry_year required | integer |
{- "number": "string",
- "cvv": "string",
- "expiry_month": 6,
- "expiry_year": 2025
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "expiry_month": 6,
- "expiry_year": 2025,
- "last_digit": "7890",
- "is_expired": true
}| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "region": "string",
- "cloud_provider": "AWS",
- "min_running_nodes": 1,
- "max_running_nodes": 1,
- "disk_size": 50,
- "instance_type": "T3A_LARGE",
- "kubernetes": "K3S",
- "cpu": 10000,
- "memory": 4096,
- "estimated_cloud_provider_cost": 0,
- "status": "BUILDING",
- "has_access": true,
- "version": "string",
- "is_default": true,
- "production": true,
- "ssh_keys": [
- "string"
], - "features": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "cost_per_month_in_cents": 9900,
- "cost_per_month": 99,
- "currency_code": "USD",
- "value_type": "BOOLEAN",
- "value": "string",
- "is_value_updatable": false,
- "accepted_values": [
- "string"
]
}
]
}
]
}| organizationId required | string <uuid> Organization ID |
| name required | string name is case-insensitive |
| description | string |
| region required | string |
| cloud_provider required | string (CloudProviderEnum) Enum: "AWS" "DO" "SCW" |
| min_running_nodes | integer Default: 1 |
| max_running_nodes | integer Default: 1 |
| disk_size | integer Default: 20 Unit is in GB. The disk size to be used for the node configuration |
| instance_type | string the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType |
| kubernetes | string (KubernetesEnum) Enum: "K3S" "MANAGED" |
| production | boolean specific flag to indicate that this cluster is a production one |
| ssh_keys | Array of strings Indicate your public ssh_key to remotely connect to your EC2 instance. |
Array of objects |
{- "name": "string",
- "description": "string",
- "region": "string",
- "cloud_provider": "AWS",
- "min_running_nodes": 1,
- "max_running_nodes": 1,
- "disk_size": 50,
- "instance_type": "T3A_LARGE",
- "kubernetes": "K3S",
- "production": true,
- "ssh_keys": [
- "string"
], - "features": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "region": "string",
- "cloud_provider": "AWS",
- "min_running_nodes": 1,
- "max_running_nodes": 1,
- "disk_size": 50,
- "instance_type": "T3A_LARGE",
- "kubernetes": "K3S",
- "cpu": 10000,
- "memory": 4096,
- "estimated_cloud_provider_cost": 0,
- "status": "BUILDING",
- "has_access": true,
- "version": "string",
- "is_default": true,
- "production": true,
- "ssh_keys": [
- "string"
], - "features": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "cost_per_month_in_cents": 9900,
- "cost_per_month": 99,
- "currency_code": "USD",
- "value_type": "BOOLEAN",
- "value": "string",
- "is_value_updatable": false,
- "accepted_values": [
- "string"
]
}
]
}Returns a list of clusters with only their id and status.
| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "status": "BUILDING",
- "is_deployed": true,
- "last_execution_id": "f73e3833-922a-48a5-9dbd-6163f43f9143-1656410242"
}
]
}| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
| name required | string name is case-insensitive |
| description | string |
| region required | string |
| cloud_provider required | string (CloudProviderEnum) Enum: "AWS" "DO" "SCW" |
| min_running_nodes | integer Default: 1 |
| max_running_nodes | integer Default: 1 |
| disk_size | integer Default: 20 Unit is in GB. The disk size to be used for the node configuration |
| instance_type | string the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType |
| kubernetes | string (KubernetesEnum) Enum: "K3S" "MANAGED" |
| production | boolean specific flag to indicate that this cluster is a production one |
| ssh_keys | Array of strings Indicate your public ssh_key to remotely connect to your EC2 instance. |
Array of objects |
{- "name": "string",
- "description": "string",
- "region": "string",
- "cloud_provider": "AWS",
- "min_running_nodes": 1,
- "max_running_nodes": 1,
- "disk_size": 50,
- "instance_type": "T3A_LARGE",
- "kubernetes": "K3S",
- "production": true,
- "ssh_keys": [
- "string"
], - "features": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "region": "string",
- "cloud_provider": "AWS",
- "min_running_nodes": 1,
- "max_running_nodes": 1,
- "disk_size": 50,
- "instance_type": "T3A_LARGE",
- "kubernetes": "K3S",
- "cpu": 10000,
- "memory": 4096,
- "estimated_cloud_provider_cost": 0,
- "status": "BUILDING",
- "has_access": true,
- "version": "string",
- "is_default": true,
- "production": true,
- "ssh_keys": [
- "string"
], - "features": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "cost_per_month_in_cents": 9900,
- "cost_per_month": 99,
- "currency_code": "USD",
- "value_type": "BOOLEAN",
- "value": "string",
- "is_value_updatable": false,
- "accepted_values": [
- "string"
]
}
]
}| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "status": "BUILDING",
- "is_deployed": true,
- "last_execution_id": "f73e3833-922a-48a5-9dbd-6163f43f9143-1656410242"
}Get list and values of the advanced settings of the cluster.
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "registry.image_retention_time": 31536000,
- "load_balancer.size": "lb-s",
- "pleco.resources_ttl": -1,
- "loki.log_retention_in_week": 12
}Edit advanced settings by returning table of advanced settings.
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
| registry.image_retention_time | integer Default: 31536000 Configure the number of seconds before cleaning images in the registry |
| load_balancer.size | string Default: "lb-s" Select the size of the main load_balancer (only effective for Scaleway) |
| pleco.resources_ttl | integer Deprecated Default: -1 |
| loki.log_retention_in_week | integer Default: 12 For how long in week loki is going to keep logs of your applications |
{- "registry.image_retention_time": 31536000,
- "load_balancer.size": "lb-s",
- "pleco.resources_ttl": -1,
- "loki.log_retention_in_week": 12
}{- "registry.image_retention_time": 31536000,
- "load_balancer.size": "lb-s",
- "pleco.resources_ttl": -1,
- "loki.log_retention_in_week": 12
}Retrieve network routing table where each line corresponds to a route between a destination and a target.
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "results": [
- {
- "destination": "string",
- "target": "string",
- "description": "string"
}
]
}Edit routing table by returning updated table.
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
required | Array of objects |
{- "routes": [
- {
- "destination": "string",
- "target": "string",
- "description": "string"
}
]
}{- "results": [
- {
- "destination": "string",
- "target": "string",
- "description": "string"
}
]
}List Cluster Logs
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "results": [
- {
- "type": "info",
- "timestamp": "2022-06-22T14:20:17.733084815Z",
- "step": "Create",
- "message": {
- "safe_message": "Preparing to delete EKS cluster."
}, - "error": {
- "tag": "CANNOT_UNINSTALL_HELM_CHART",
- "user_log_message": "Wasn't able to delete all objects type Cert-Manager",
- "link": "string",
- "hint_message": "string",
- "event_details": {
- "provider_kind": "aws",
- "region": "eu-west-3",
- "transmitter": {
- "type": "kubernetes",
- "id": "za6ecdf3f",
- "name": "cluster-name"
}
}, - "underlying_error": {
- "message": "string"
}
}, - "details": {
- "provider_kind": "aws",
- "region": "eu-west-3",
- "transmitter": {
- "type": "kubernetes",
- "id": "za6ecdf3f",
- "name": "cluster-name"
}
}
}
]
}| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "cloud_provider": "AWS",
- "credentials": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "region": "string"
}| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
| cloud_provider | string (CloudProviderEnum) Enum: "AWS" "DO" "SCW" |
object | |
| region | string |
{- "cloud_provider": "AWS",
- "credentials": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "region": "string"
}{- "cloud_provider": "AWS",
- "credentials": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "region": "string"
}allows to deploy a cluster
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "status": "BUILDING",
- "is_deployed": true
}allows to update cluster version
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "status": "BUILDING",
- "is_deployed": true
}Cluster stop has been requester.
| organizationId required | string <uuid> Organization ID |
| clusterId required | string <uuid> Cluster ID |
{- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "status": "BUILDING",
- "is_deployed": true
}{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "cost_per_month_in_cents": 9900,
- "cost_per_month": 99,
- "currency_code": "USD",
- "value_type": "BOOLEAN",
- "value": "string",
- "is_value_updatable": false,
- "accepted_values": [
- "string"
]
}
]
}| region required | string Example: us-east-2 region name |
{- "results": [
- {
- "type": "T3A_XLARGE",
- "name": "t3a.xlarge",
- "cpu": 2,
- "ram_in_gb": 8,
- "bandwidth_in_gbps": "5.2",
- "bandwidth_guarantee": "UpTo"
}
]
}| region required | string Example: us-east-2 region name |
{- "results": [
- {
- "type": "T3A_XLARGE",
- "name": "t3a.xlarge",
- "cpu": 2,
- "ram_in_gb": 8,
- "bandwidth_in_gbps": "5.2",
- "bandwidth_guarantee": "UpTo"
}
]
}{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "cost_per_month_in_cents": 9900,
- "cost_per_month": 99,
- "currency_code": "USD",
- "value_type": "BOOLEAN",
- "value": "string",
- "is_value_updatable": false,
- "accepted_values": [
- "string"
]
}
]
}{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "cost_per_month_in_cents": 9900,
- "cost_per_month": 99,
- "currency_code": "USD",
- "value_type": "BOOLEAN",
- "value": "string",
- "is_value_updatable": false,
- "accepted_values": [
- "string"
]
}
]
}| zone required | string Example: fr-par-1 zone name |
{- "results": [
- {
- "type": "T3A_XLARGE",
- "name": "t3a.xlarge",
- "cpu": 2,
- "ram_in_gb": 8,
- "bandwidth_in_gbps": "5.2",
- "bandwidth_guarantee": "UpTo"
}
]
}| organizationId required | string <uuid> Organization ID |
| name required | string |
| access_key_id required | string |
| secret_access_key required | string |
{- "name": "string",
- "access_key_id": "string",
- "secret_access_key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}| organizationId required | string <uuid> Organization ID |
| credentialsId required | string <uuid> Credentials ID |
| name required | string |
| access_key_id required | string |
| secret_access_key required | string |
{- "name": "string",
- "access_key_id": "string",
- "secret_access_key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}| organizationId required | string <uuid> Organization ID |
| name required | string |
| token | string |
| spaces_access_id | string |
| spaces_secret_key | string |
{- "name": "string",
- "token": "string",
- "spaces_access_id": "string",
- "spaces_secret_key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}| organizationId required | string <uuid> Organization ID |
| credentialsId required | string <uuid> Credentials ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}| organizationId required | string <uuid> Organization ID |
| credentialsId required | string <uuid> Credentials ID |
| name required | string |
| token | string |
| spaces_access_id | string |
| spaces_secret_key | string |
{- "name": "string",
- "token": "string",
- "spaces_access_id": "string",
- "spaces_secret_key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}| organizationId required | string <uuid> Organization ID |
| name required | string |
| scaleway_access_key | string |
| scaleway_secret_key | string |
| scaleway_project_id | string |
{- "name": "string",
- "scaleway_access_key": "string",
- "scaleway_secret_key": "string",
- "scaleway_project_id": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}| organizationId required | string <uuid> Organization ID |
| credentialsId required | string <uuid> Credentials ID |
| name required | string |
| scaleway_access_key | string |
| scaleway_secret_key | string |
| scaleway_project_id | string |
{- "name": "string",
- "scaleway_access_key": "string",
- "scaleway_secret_key": "string",
- "scaleway_project_id": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}| organizationId required | string <uuid> Organization ID |
| installation_id required | string |
| code required | string |
{- "installation_id": "string",
- "code": "string"
}| organizationId required | string <uuid> Organization ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "ECR",
- "description": "string",
- "url": "string",
- "cluster": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string"
}
}
]
}| organizationId required | string <uuid> Organization ID |
| name required | string |
| kind required | string (ContainerRegistryKindEnum) Enum: "ECR" "SCALEWAY_CR" "DOCKER_HUB" "PUBLIC_ECR" "DOCR" The type of your container registry |
| description | string |
| url | string <uri> URL of the container registry:
|
required | object This field is dependent of the container registry kind:
|
{- "name": "string",
- "kind": "ECR",
- "description": "string",
- "config": {
- "access_key_id": "string",
- "secret_access_key": "string",
- "region": "string",
- "scaleway_access_key": "string",
- "scaleway_secret_key": "string",
- "username": "string",
- "password": "string"
}
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "ECR",
- "description": "string",
- "url": "string",
- "cluster": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string"
}
}| organizationId required | string <uuid> Organization ID |
| containerRegistryId required | string <uuid> Container Registry ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "ECR",
- "description": "string",
- "url": "string",
- "cluster": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string"
}
}| organizationId required | string <uuid> Organization ID |
| containerRegistryId required | string <uuid> Container Registry ID |
| name required | string |
| kind required | string (ContainerRegistryKindEnum) Enum: "ECR" "SCALEWAY_CR" "DOCKER_HUB" "PUBLIC_ECR" "DOCR" The type of your container registry |
| description | string |
| url | string <uri> URL of the container registry:
|
required | object This field is dependent of the container registry kind:
|
{- "name": "string",
- "kind": "ECR",
- "description": "string",
- "config": {
- "access_key_id": "string",
- "secret_access_key": "string",
- "region": "string",
- "scaleway_access_key": "string",
- "scaleway_secret_key": "string",
- "username": "string",
- "password": "string"
}
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "ECR",
- "description": "string",
- "url": "string",
- "cluster": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string"
}
}| projectId required | string <uuid> Project ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}To edit a project you must have the admin permission
| projectId required | string <uuid> Project ID |
| name required | string name is case insensitive |
| description | string |
{- "name": "string",
- "description": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}| projectId required | string <uuid> Project ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
- "cloud_provider": {
- "provider": "aws",
- "cluster": "us-east-2"
}, - "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string"
}
]
}| projectId required | string <uuid> Project ID |
| name required | string name is case insensitive |
| cluster | string <uuid> |
| mode | string (CreateEnvironmentModeEnum) Enum: "DEVELOPMENT" "PRODUCTION" "STAGING" |
{- "name": "string",
- "cluster": "75f2c581-ef2d-4437-9fa8-a27342452fc4",
- "mode": "PRODUCTION"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
- "cloud_provider": {
- "provider": "aws",
- "cluster": "us-east-2"
}, - "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string"
}Returns a list of environments with only their id and status.
| projectId required | string <uuid> Project ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}
]
}Returns a list of environment ids, and for each its total numberof services
| projectId required | string <uuid> Project ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "service_total_number": 0
}
]
}List project deployment rules
| projectId required | string <uuid> Project ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "project-rule",
- "description": "description project rule",
- "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "auto_deploy": false,
- "auto_stop": false,
- "auto_delete": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
], - "wildcard": "",
- "priority_index": 0
}
]
}Create a deployment rule
| projectId required | string <uuid> Project ID |
| name required | string name is case insensitive |
| description | string or null |
| mode required | string (EnvironmentModeEnum) Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING" |
| cluster_id required | string <uuid> |
| auto_deploy | boolean Default: false |
| auto_stop | boolean Default: false |
| auto_delete | boolean Default: false |
| timezone required | string |
| start_time required | string <date-time> |
| stop_time required | string <date-time> |
| weekdays required | Array of strings (WeekdayEnum) Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY" |
| wildcard required | string Default: "" wildcard pattern composed of '?' and/or '*' used to target new created environments |
{- "name": "project-rule",
- "description": "description project rule",
- "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "auto_deploy": false,
- "auto_stop": false,
- "auto_delete": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
], - "wildcard": ""
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "project-rule",
- "description": "description project rule",
- "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "auto_deploy": false,
- "auto_stop": false,
- "auto_delete": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
], - "wildcard": "",
- "priority_index": 0
}Get a project deployment rule
| projectId required | string <uuid> Project ID |
| deploymentRuleId required | string <uuid> Deployment Rule ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "project-rule",
- "description": "description project rule",
- "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "auto_deploy": false,
- "auto_stop": false,
- "auto_delete": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
], - "wildcard": "",
- "priority_index": 0
}Edit a project deployment rule
| projectId required | string <uuid> Project ID |
| deploymentRuleId required | string <uuid> Deployment Rule ID |
| name required | string name is case insensitive |
| description | string or null |
| mode required | string (EnvironmentModeEnum) Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING" |
| cluster_id required | string <uuid> |
| auto_deploy | boolean Default: false |
| auto_stop | boolean Default: false |
| auto_delete | boolean Default: false |
| timezone required | string |
| start_time required | string <date-time> |
| stop_time required | string <date-time> |
| weekdays required | Array of strings (WeekdayEnum) Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY" |
| wildcard required | string Default: "" wildcard pattern composed of '?' and/or '*' used to target new created environments |
{- "name": "project-rule",
- "description": "description project rule",
- "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "auto_deploy": false,
- "auto_stop": false,
- "auto_delete": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
], - "wildcard": ""
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "project-rule",
- "description": "description project rule",
- "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "auto_deploy": false,
- "auto_stop": false,
- "auto_delete": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
], - "wildcard": "",
- "priority_index": 0
}Update deployment rules priority order
| projectId required | string <uuid> Project ID |
| project_deployment_rule_ids_in_order | Array of strings <uuid> |
{- "project_deployment_rule_ids_in_order": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| projectId required | string <uuid> Project ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}
]
}| projectId required | string <uuid> Project ID |
| key required | string key is case sensitive |
| value required | string value of the env variable. |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| projectId required | string <uuid> Project ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| projectId required | string <uuid> Project ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| key required | string key is case sensitive |
| value required | string value of the env variable. |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| projectId required | string <uuid> Project ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| value required | string |
{- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| projectId required | string <uuid> Project ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| key required | string |
{- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| projectId required | string <uuid> Project ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}
]
}| projectId required | string <uuid> Project ID |
| key required | string key is case sensitive |
| value required | string value of the secret. Clear value will never be returned |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| projectId required | string <uuid> Project ID |
| secretId required | string <uuid> Secret ID |
| projectId required | string <uuid> Project ID |
| secretId required | string <uuid> Secret ID |
| value required | string |
| key required | string |
{- "value": "string",
- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| projectId required | string <uuid> Project ID |
| secretId required | string <uuid> Secret ID |
| value required | string |
{- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| projectId required | string <uuid> Project ID |
| secretId required | string <uuid> Secret ID |
| key required | string |
{- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| environmentId required | string <uuid> Environment ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
- "cloud_provider": {
- "provider": "aws",
- "cluster": "us-east-2"
}, - "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string"
}To edit an environment you must have the admin permission
| environmentId required | string <uuid> Environment ID |
| name | string |
| mode | string (CreateEnvironmentModeEnum) Enum: "DEVELOPMENT" "PRODUCTION" "STAGING" |
{- "name": "string",
- "mode": "PRODUCTION"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
- "cloud_provider": {
- "provider": "aws",
- "cluster": "us-east-2"
}, - "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string"
}| environmentId required | string <uuid> Environment ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| environmentId required | string <uuid> Environment ID |
| toUpdate | boolean Default: false return (or not) results that must be updated |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "git_repository": {
- "has_access": true,
- "provider": "BITBUCKET",
- "owner": "John Doe",
- "name": "simple-node-app",
- "branch": "string",
- "root_path": "string",
- "deployed_commit_id": "string",
- "deployed_commit_date": "2019-08-24T14:15:22Z",
- "deployed_commit_contributor": "4156f3f4-0b43-4670-b2ef-cd6803200694",
- "deployed_commit_tag": "v1.0.1"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "description": "string",
- "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}
]
}| environmentId required | string <uuid> Environment ID |
Array of objects | |
Array of objects | |
| name required | string name is case insensitive |
| description | string or null give a description to this application |
required | object (ApplicationGitRepositoryRequest) |
| build_mode | string (BuildModeEnum) Default: "BUILDPACKS" Enum: "BUILDPACKS" "DOCKER"
|
| dockerfile_path | string or null The path of the associated Dockerfile. Only if you are using build_mode = DOCKER |
| buildpack_language | string or null (BuildPackLanguageEnum) Enum: "CLOJURE" "GO" "GRADLE" "GRAILS" "JAVA" "JVM" "NODE_JS" "PHP" "PLAY" "PYTHON" "SCALA" Development language of the application |
| cpu | integer Default: 500 unit is millicores (m). 1000m = 1 cpu |
| memory | integer Default: 512 unit is MB. 1024 MB = 1GB |
| min_running_instances | integer >= 0 Default: 1 Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running. |
| max_running_instances | integer Default: 1 Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. |
object (Healthcheck) | |
| auto_preview | boolean Default: true Specify if the environment preview option is activated or not for this application. |
{- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "ports": [
- {
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
], - "name": "string",
- "description": "string",
- "git_repository": {
- "branch": "feat/text_xxx",
- "root_path": "/"
}, - "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "git_repository": {
- "has_access": true,
- "provider": "BITBUCKET",
- "owner": "John Doe",
- "name": "simple-node-app",
- "branch": "string",
- "root_path": "string",
- "deployed_commit_id": "string",
- "deployed_commit_date": "2019-08-24T14:15:22Z",
- "deployed_commit_contributor": "4156f3f4-0b43-4670-b2ef-cd6803200694",
- "deployed_commit_tag": "v1.0.1"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "description": "string",
- "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}Returns a list of applications with only their id and status.
| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}
]
}| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "disks": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "storage_id": "string",
- "requested_in_gb": 0,
- "consumed_in_gb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}
]
}
]
}Returns min, max, and running number of instances for each application
| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "min": 0,
- "max": 0,
- "running": 0,
- "running_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}{- "deployment.delay_start_time_sec": 30,
- "deployment.custom_domain_check_enabled": true,
- "build.timeout_max_sec": 1800,
- "network.ingress.proxy_body_size_mb": 100,
- "network.ingress.enable_cors": false,
- "network.ingress.cors_allow_origin": "*",
- "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
- "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
- "network.ingress.proxy_buffer_size_kb": 4,
- "network.ingress.keepalive_time_seconds": 3600,
- "network.ingress.keepalive_timeout_seconds": 60,
- "network.ingress.send_timeout_seconds": 60,
- "network.ingress.proxy_connect_timeout_seconds": 60,
- "network.ingress.proxy_send_timeout_seconds": 60,
- "network.ingress.proxy_read_timeout_seconds": 60,
- "network.ingress.whitelist_source_range": "0.0.0.0/0",
- "readiness_probe.type": "NONE",
- "readiness_probe.http_get.path": "/",
- "readiness_probe.initial_delay_seconds": 30,
- "readiness_probe.period_seconds": 10,
- "readiness_probe.timeout_seconds": 1,
- "readiness_probe.success_threshold": 1,
- "readiness_probe.failure_threshold": 3,
- "liveness_probe.type": "NONE",
- "liveness_probe.http_get.path": "/",
- "liveness_probe.initial_delay_seconds": 30,
- "liveness_probe.period_seconds": 10,
- "liveness_probe.timeout_seconds": 5,
- "liveness_probe.success_threshold": 1,
- "liveness_probe.failure_threshold": 3,
- "hpa.cpu.average_utilization_percent": 60
}Returns a list of containers with only their id and status.
| organizationId required | string <uuid> Organization ID |
| containerRegistryId required | string <uuid> Container Registry ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}
]
}| environmentId required | string <uuid> Environment ID |
| toUpdate | boolean Default: false return (or not) results that must be updated |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "registry": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}
]
}| environmentId required | string <uuid> Environment ID |
Array of objects | |
Array of objects | |
| name required | string name is case insensitive |
| registry_id required | string id of the linked registry |
| image_name required | string The image name pattern differs according to chosen container registry provider:
|
| tag required | string tag of the image container |
| arguments | Array of strings |
| entrypoint | string optional entrypoint when launching container |
| cpu | integer Default: 500 unit is millicores (m). 1000m = 1 cpu |
| memory | integer Default: 512 unit is MB. 1024 MB = 1GB |
| min_running_instances | integer >= 0 Default: 1 Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running. |
| max_running_instances | integer Default: 1 Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. |
| auto_preview | boolean Indicates if the 'environment preview option' is enabled for this container. |
{- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "ports": [
- {
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
], - "name": "string",
- "registry_id": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "registry": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}Returns a list of containers with only their id and status.
| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}
]
}| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "container": "535b2ef6-b421-4f22-b71e-889193be847c",
- "disks": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "storage_id": "string",
- "requested_in_gb": 0,
- "consumed_in_gb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}
]
}
]
}Returns min, max, and running number of instances for each container
| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "container": "535b2ef6-b421-4f22-b71e-889193be847c",
- "min": 0,
- "max": 0,
- "running": 0,
- "running_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}Update and deploy the selected services
| environmentId required | string <uuid> Environment ID |
Array of objects | |
Array of objects |
{- "applications": [
- {
- "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
- "git_commit_id": "string"
}
], - "containers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_tag": "string"
}
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}Triggers a new container deploy in each environment matching the following conditions
| organizationId required | string <uuid> Organization ID |
| image_name | string the container image name to deploy |
| tag | string the new tag to deploy |
{- "image_name": "string",
- "tag": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}Triggers a new container preview for each environment matching the following conditions
| organizationId required | string <uuid> Organization ID |
| image_name | string the container image name to trigger preview environment |
| tag | string the tag to be used in the preview environment |
{- "image_name": "string",
- "tag": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "database_type": "MONGODB",
- "version": [
- {
- "name": "10.1",
- "supported_mode": "CONTAINER"
}
]
}
]
}| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "type": "MONGODB",
- "version": "10.1",
- "mode": "CONTAINER",
- "accessibility": "PRIVATE",
- "cpu": 1250,
- "memory": 1024,
- "storage": 10,
- "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "host": "string",
- "port": 5432,
- "maximum_cpu": 1250,
- "maximum_memory": 1024,
- "disk_encrypted": true
}
]
}| environmentId required | string <uuid> Environment ID |
| name required | string name is case insensitive |
| type required | string (DatabaseTypeEnum) Enum: "MONGODB" "MYSQL" "POSTGRESQL" "REDIS" |
| version required | string |
| mode required | string (DatabaseModeEnum) Enum: "CONTAINER" "MANAGED" |
| accessibility | string (DatabaseAccessibilityEnum) Default: "PRIVATE" Enum: "PRIVATE" "PUBLIC" |
| cpu | integer Default: 250 unit is millicores (m). 1000m = 1 cpu |
| memory | integer unit is MB. 1024 MB = 1GB
|
| storage | integer Default: 10 unit is GB |
{- "name": "string",
- "type": "MONGODB",
- "version": "10.1",
- "mode": "CONTAINER",
- "accessibility": "PRIVATE",
- "cpu": 1250,
- "memory": 1024,
- "storage": 10
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "type": "MONGODB",
- "version": "10.1",
- "mode": "CONTAINER",
- "accessibility": "PRIVATE",
- "cpu": 1250,
- "memory": 1024,
- "storage": 10,
- "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "host": "string",
- "port": 5432,
- "maximum_cpu": 1250,
- "maximum_memory": 1024,
- "disk_encrypted": true
}Returns a list of databases with only their id and status.
| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}
]
}| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "database": "df8eac19-d158-497f-ac84-447e3d8cf906",
- "cpu": {
- "requested_in_float": 0,
- "consumed_in_number": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}, - "memory": {
- "requested_in_mb": 0,
- "consumed_in_mb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}, - "storage": {
- "requested_in_gb": 0,
- "consumed_in_gb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}
}
]
}This will deploy all the services of this environment to their latest version.
| environmentId required | string <uuid> Environment ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| environmentId required | string <uuid> Environment ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| environmentId required | string <uuid> Environment ID |
| restart_db | boolean Default: false |
{- "restart_db": false
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}Cancel the current deployment of your environment.
| environmentId required | string <uuid> Environment ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}You must provide a name. This will create a new environment, with the same configuration, and same applications and databases. Database data is not cloned.
| environmentId required | string <uuid> Environment ID |
| name required | string name is case insensitive |
| cluster_id | string <uuid> |
| mode | string (EnvironmentModeEnum) Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING" |
{- "name": "string",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "mode": "PRODUCTION"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
- "cloud_provider": {
- "provider": "aws",
- "cluster": "us-east-2"
}, - "mode": "PRODUCTION",
- "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
- "cluster_name": "string"
}This returns the last 1000 environment deployment logs.
| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "scope": {
- "type": "APPLICATION",
- "name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "state": "CANCELED",
- "message": "string",
- "execution_id": "string",
- "hint": "only for errors. it gives a possible action to the user -- Markdown can be injected"
}
]
}List previous and current environment deployments with the status deployment and the related services. By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter
| environmentId required | string <uuid> Environment ID |
| startId | string <uuid> Starting point after which to return results |
{- "page": 1,
- "page_size": 20,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "status": "BUILDING",
- "applications": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "commit": {
- "created_at": "2019-08-24T14:15:22Z",
- "git_commit_id": "string",
- "tag": "v2.1.1",
- "message": "string",
- "author_name": "string",
- "author_avatar_url": "string",
- "commit_page_url": "string"
}, - "status": "BUILDING"
}
], - "containers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "FAILED",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string"
}
], - "databases": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "FAILED"
}
]
}
]
}| environmentId required | string <uuid> Environment ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "auto_deploy": true,
- "auto_stop": false,
- "auto_delete": false,
- "auto_preview": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
]
}| environmentId required | string <uuid> Environment ID |
| deploymentRuleId required | string <uuid> Deployment Rule ID |
| auto_deploy | boolean Default: true |
| auto_delete | boolean Default: false |
| auto_stop | boolean Default: false |
| timezone required | string |
| start_time required | string <date-time> |
| stop_time required | string <date-time> |
| weekdays required | Array of strings (WeekdayEnum) Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY" |
{- "auto_deploy": true,
- "auto_delete": false,
- "auto_stop": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "auto_deploy": true,
- "auto_stop": false,
- "auto_delete": false,
- "auto_preview": false,
- "timezone": "UTC",
- "start_time": "1970-01-01T08:00:00.000Z",
- "stop_time": "1970-01-01T19:00:00.000Z",
- "weekdays": [
- "MONDAY"
]
}| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}
]
}| environmentId required | string <uuid> Environment ID |
| key required | string key is case sensitive |
| value required | string value of the env variable. |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| environmentId required | string <uuid> Environment ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| environmentId required | string <uuid> Environment ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| key required | string key is case sensitive |
| value required | string value of the env variable. |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| environmentId required | string <uuid> Environment ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| value required | string |
{- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| environmentId required | string <uuid> Environment ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| key required | string |
{- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| environmentId required | string <uuid> Environment ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}
]
}| environmentId required | string <uuid> Environment ID |
| key required | string key is case sensitive |
| value required | string value of the secret. Clear value will never be returned |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| environmentId required | string <uuid> Environment ID |
| secretId required | string <uuid> Secret ID |
| environmentId required | string <uuid> Environment ID |
| secretId required | string <uuid> Secret ID |
| value required | string |
| key required | string |
{- "value": "string",
- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| environmentId required | string <uuid> Environment ID |
| secretId required | string <uuid> Secret ID |
| value required | string |
{- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| environmentId required | string <uuid> Environment ID |
| secretId required | string <uuid> Secret ID |
| key required | string |
{- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| applicationId required | string <uuid> Application ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "git_repository": {
- "has_access": true,
- "provider": "BITBUCKET",
- "owner": "John Doe",
- "name": "simple-node-app",
- "branch": "string",
- "root_path": "string",
- "deployed_commit_id": "string",
- "deployed_commit_date": "2019-08-24T14:15:22Z",
- "deployed_commit_contributor": "4156f3f4-0b43-4670-b2ef-cd6803200694",
- "deployed_commit_tag": "v1.0.1"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "description": "string",
- "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}| applicationId required | string <uuid> Application ID |
Array of objects | |
| name | string name is case insensitive |
| description | string give a description to this application |
object (ApplicationGitRepositoryRequest) | |
| build_mode | string (BuildModeEnum) Default: "BUILDPACKS" Enum: "BUILDPACKS" "DOCKER"
|
| dockerfile_path | string The path of the associated Dockerfile |
| buildpack_language | string or null (BuildPackLanguageEnum) Enum: "CLOJURE" "GO" "GRADLE" "GRAILS" "JAVA" "JVM" "NODE_JS" "PHP" "PLAY" "PYTHON" "SCALA" Development language of the application |
| cpu | integer Default: 500 unit is millicores (m). 1000m = 1 cpu |
| memory | integer Default: 512 unit is MB. 1024 MB = 1GB |
| min_running_instances | integer >= 0 Default: 1 Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running. |
| max_running_instances | integer Default: 1 Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. |
object (Healthcheck) | |
| auto_preview | boolean Default: true Specify if the environment preview option is activated or not for this application. |
| sticky_session | boolean Default: false Specify if the sticky session option (also called persistant session) is activated or not for this application. If activated, user will be redirected by the load balancer to the same instance each time he access to the application. |
Array of objects (ServicePortResponseList) |
{- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "name": "string",
- "description": "string",
- "git_repository": {
- "branch": "feat/text_xxx",
- "root_path": "/"
}, - "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "sticky_session": false,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "git_repository": {
- "has_access": true,
- "provider": "BITBUCKET",
- "owner": "John Doe",
- "name": "simple-node-app",
- "branch": "string",
- "root_path": "string",
- "deployed_commit_id": "string",
- "deployed_commit_date": "2019-08-24T14:15:22Z",
- "deployed_commit_contributor": "4156f3f4-0b43-4670-b2ef-cd6803200694",
- "deployed_commit_tag": "v1.0.1"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "description": "string",
- "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}| applicationId required | string <uuid> Application ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
}
]
}| applicationId required | string <uuid> Application ID |
| name required | string |
{- "name": "string"
}{- "results": [
- {
- "name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}Returns list of the last 100 commits made on the repository linked to the application
| applicationId required | string <uuid> Application ID |
| startId | string <uuid> Starting point after which to return results |
| gitCommitId | string <uuid> Git Commit ID |
{- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "git_commit_id": "string",
- "tag": "v2.1.1",
- "message": "string",
- "author_name": "string",
- "author_avatar_url": "string",
- "commit_page_url": "string"
}
]
}This will return all the custom domains and Qovery autogenerated domain for the given application
| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "url": "string"
}
]
}You must provide a git commit id
| applicationId required | string <uuid> Application ID |
| git_commit_id required | string Commit ID to deploy |
{- "git_commit_id": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| applicationId required | string <uuid> Application ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| applicationId required | string <uuid> Application ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}Edit the Network settings of the application.
| applicationId required | string <uuid> Application ID |
| sticky_session | boolean Default: false Specify if the sticky session option (also called persistant session) is activated or not for this application. If activated, user will be redirected by the load balancer to the same instance each time he access to the application. |
{- "sticky_session": false
}{- "sticky_session": false
}Get list and values of the advanced settings of the application.
| applicationId required | string <uuid> Application ID |
{- "deployment.delay_start_time_sec": 30,
- "deployment.custom_domain_check_enabled": true,
- "build.timeout_max_sec": 1800,
- "network.ingress.proxy_body_size_mb": 100,
- "network.ingress.enable_cors": false,
- "network.ingress.cors_allow_origin": "*",
- "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
- "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
- "network.ingress.proxy_buffer_size_kb": 4,
- "network.ingress.keepalive_time_seconds": 3600,
- "network.ingress.keepalive_timeout_seconds": 60,
- "network.ingress.send_timeout_seconds": 60,
- "network.ingress.proxy_connect_timeout_seconds": 60,
- "network.ingress.proxy_send_timeout_seconds": 60,
- "network.ingress.proxy_read_timeout_seconds": 60,
- "network.ingress.whitelist_source_range": "0.0.0.0/0",
- "readiness_probe.type": "NONE",
- "readiness_probe.http_get.path": "/",
- "readiness_probe.initial_delay_seconds": 30,
- "readiness_probe.period_seconds": 10,
- "readiness_probe.timeout_seconds": 1,
- "readiness_probe.success_threshold": 1,
- "readiness_probe.failure_threshold": 3,
- "liveness_probe.type": "NONE",
- "liveness_probe.http_get.path": "/",
- "liveness_probe.initial_delay_seconds": 30,
- "liveness_probe.period_seconds": 10,
- "liveness_probe.timeout_seconds": 5,
- "liveness_probe.success_threshold": 1,
- "liveness_probe.failure_threshold": 3,
- "hpa.cpu.average_utilization_percent": 60
}Edit advanced settings by returning table of advanced settings.
| applicationId required | string <uuid> Application ID |
| deployment.delay_start_time_sec | integer Deprecated Default: 30 please use |
| deployment.custom_domain_check_enabled | boolean Default: true disable custom domain check when deploying an application |
| build.timeout_max_sec | integer Default: 1800 |
| network.ingress.proxy_body_size_mb | integer Default: 100 |
| network.ingress.enable_cors | boolean Default: false |
| network.ingress.cors_allow_origin | string Default: "*" |
| network.ingress.cors_allow_methods | string Default: "GET, PUT, POST, DELETE, PATCH, OPTIONS" |
| network.ingress.cors_allow_headers | string Default: "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" |
| network.ingress.proxy_buffer_size_kb | integer Default: 4 header buffer size used while reading response header from upstream |
| network.ingress.keepalive_time_seconds | integer Default: 3600 Limits the maximum time (in seconds) during which requests can be processed through one keepalive connection |
| network.ingress.keepalive_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) during which an idle keepalive connection to an upstream server will stay open. |
| network.ingress.send_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for transmitting a response to the client |
| network.ingress.proxy_connect_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for establishing a connection to a proxied server |
| network.ingress.proxy_send_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for transmitting a request to the proxied server |
| network.ingress.proxy_read_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for reading a response from the proxied server |
| network.ingress.whitelist_source_range | string Default: "0.0.0.0/0" list of source ranges to allow access to ingress proxy. This property can be used to whitelist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 To allow all source ranges, set 0.0.0.0/0. |
| readiness_probe.type | string Default: "TCP" Enum: "NONE" "TCP" "HTTP"
|
| readiness_probe.http_get.path | string Default: "/" HTTP GET path to check status (must returns 2xx E.g "/healtz") - only usable with TYPE = HTTP |
| readiness_probe.initial_delay_seconds | integer Default: 30 Delay before liveness probe is initiated |
| readiness_probe.period_seconds | integer Default: 10 How often to perform the probe |
| readiness_probe.timeout_seconds | integer Default: 1 When the probe times out |
| readiness_probe.success_threshold | integer Default: 1 Minimum consecutive successes for the probe to be considered successful after having failed. |
| readiness_probe.failure_threshold | integer Default: 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. |
| liveness_probe.type | string Default: "TCP" Enum: "NONE" "TCP" "HTTP"
|
| liveness_probe.http_get.path | string Default: "/" HTTP GET path to check status (must returns 2xx E.g "/healtz") - only usable with TYPE = HTTP |
| liveness_probe.initial_delay_seconds | integer Default: 30 Delay before liveness probe is initiated |
| liveness_probe.period_seconds | integer Default: 10 How often to perform the probe |
| liveness_probe.timeout_seconds | integer Default: 5 When the probe times out |
| liveness_probe.success_threshold | integer Default: 1 Minimum consecutive successes for the probe to be considered successful after having failed. |
| liveness_probe.failure_threshold | integer Default: 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. |
| hpa.cpu.average_utilization_percent | integer Default: 60 Percentage value of cpu usage at which point pods should scale up. |
{- "deployment.delay_start_time_sec": 30,
- "deployment.custom_domain_check_enabled": true,
- "build.timeout_max_sec": 1800,
- "network.ingress.proxy_body_size_mb": 100,
- "network.ingress.enable_cors": false,
- "network.ingress.cors_allow_origin": "*",
- "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
- "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
- "network.ingress.proxy_buffer_size_kb": 4,
- "network.ingress.keepalive_time_seconds": 3600,
- "network.ingress.keepalive_timeout_seconds": 60,
- "network.ingress.send_timeout_seconds": 60,
- "network.ingress.proxy_connect_timeout_seconds": 60,
- "network.ingress.proxy_send_timeout_seconds": 60,
- "network.ingress.proxy_read_timeout_seconds": 60,
- "network.ingress.whitelist_source_range": "0.0.0.0/0",
- "readiness_probe.type": "NONE",
- "readiness_probe.http_get.path": "/",
- "readiness_probe.initial_delay_seconds": 30,
- "readiness_probe.period_seconds": 10,
- "readiness_probe.timeout_seconds": 1,
- "readiness_probe.success_threshold": 1,
- "readiness_probe.failure_threshold": 3,
- "liveness_probe.type": "NONE",
- "liveness_probe.http_get.path": "/",
- "liveness_probe.initial_delay_seconds": 30,
- "liveness_probe.period_seconds": 10,
- "liveness_probe.timeout_seconds": 5,
- "liveness_probe.success_threshold": 1,
- "liveness_probe.failure_threshold": 3,
- "hpa.cpu.average_utilization_percent": 60
}{- "deployment.delay_start_time_sec": 30,
- "deployment.custom_domain_check_enabled": true,
- "build.timeout_max_sec": 1800,
- "network.ingress.proxy_body_size_mb": 100,
- "network.ingress.enable_cors": false,
- "network.ingress.cors_allow_origin": "*",
- "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
- "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
- "network.ingress.proxy_buffer_size_kb": 4,
- "network.ingress.keepalive_time_seconds": 3600,
- "network.ingress.keepalive_timeout_seconds": 60,
- "network.ingress.send_timeout_seconds": 60,
- "network.ingress.proxy_connect_timeout_seconds": 60,
- "network.ingress.proxy_send_timeout_seconds": 60,
- "network.ingress.proxy_read_timeout_seconds": 60,
- "network.ingress.whitelist_source_range": "0.0.0.0/0",
- "readiness_probe.type": "NONE",
- "readiness_probe.http_get.path": "/",
- "readiness_probe.initial_delay_seconds": 30,
- "readiness_probe.period_seconds": 10,
- "readiness_probe.timeout_seconds": 1,
- "readiness_probe.success_threshold": 1,
- "readiness_probe.failure_threshold": 3,
- "liveness_probe.type": "NONE",
- "liveness_probe.http_get.path": "/",
- "liveness_probe.initial_delay_seconds": 30,
- "liveness_probe.period_seconds": 10,
- "liveness_probe.timeout_seconds": 5,
- "liveness_probe.success_threshold": 1,
- "liveness_probe.failure_threshold": 3,
- "hpa.cpu.average_utilization_percent": 60
}| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "domain": "my.domain.tld",
- "validation_domain": "string",
- "status": "VALIDATION_PENDING"
}
]
}Add a custom domain to this application in order not to use qovery autogenerated domain
| applicationId required | string <uuid> Application ID |
| domain required | string your custom domain |
{- "domain": "my.domain.tld"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "domain": "my.domain.tld",
- "validation_domain": "string",
- "status": "VALIDATION_PENDING"
}To edit a Custom Domain you must have the project user permission
| applicationId required | string <uuid> Application ID |
| customDomainId required | string <uuid> Custom Domain ID |
| domain required | string your custom domain |
{- "domain": "my.domain.tld"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "domain": "my.domain.tld",
- "validation_domain": "string",
- "status": "VALIDATION_PENDING"
}| applicationId required | string <uuid> Application ID |
| customDomainId required | string <uuid> Custom Domain ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "domain": "my.domain.tld",
- "validation_domain": "string",
- "status": "VALIDATION_PENDING"
}| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "git_repository": {
- "has_access": true,
- "provider": "BITBUCKET",
- "owner": "John Doe",
- "name": "simple-node-app",
- "branch": "string",
- "root_path": "string",
- "deployed_commit_id": "string",
- "deployed_commit_date": "2019-08-24T14:15:22Z",
- "deployed_commit_contributor": "4156f3f4-0b43-4670-b2ef-cd6803200694",
- "deployed_commit_tag": "v1.0.1"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "description": "string",
- "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}
]
}Add application dependency to this application to prevent this application starting before the linked dependencies
| applicationId required | string <uuid> Application ID |
| targetApplicationId required | string <uuid> Target application ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "git_repository": {
- "has_access": true,
- "provider": "BITBUCKET",
- "owner": "John Doe",
- "name": "simple-node-app",
- "branch": "string",
- "root_path": "string",
- "deployed_commit_id": "string",
- "deployed_commit_date": "2019-08-24T14:15:22Z",
- "deployed_commit_contributor": "4156f3f4-0b43-4670-b2ef-cd6803200694",
- "deployed_commit_tag": "v1.0.1"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "description": "string",
- "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "name": "instance 1",
- "cpu": {
- "requested_in_float": 0,
- "consumed_in_number": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}, - "memory": {
- "requested_in_mb": 0,
- "consumed_in_mb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}
}
]
}| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "storage_id": "string",
- "requested_in_gb": 0,
- "consumed_in_gb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}
]
}Returns min, max, and running number of instances of the application
| applicationId required | string <uuid> Application ID |
{- "min": 0,
- "max": 0,
- "running": 0,
- "running_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert",
- "updated_at": "2019-08-24T14:15:22Z"
}| applicationId required | string <uuid> Application ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "instance_name": "instance 1",
- "data": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "requested_in_number": 0,
- "consumed_in_number": 0,
- "consumed_in_percent": 0
}
]
}
]
}| applicationId required | string <uuid> Application ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "instance_name": "instance 1",
- "data": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "requested_in_mb": 0,
- "consumed_in_mb": 0,
- "consumed_in_percent": 0
}
]
}
]
}The value returned corresponds to the 95th centile
| applicationId required | string <uuid> Application ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "instance_name": "instance 1",
- "data": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "value": 0
}
]
}
]
}| applicationId required | string <uuid> Application ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "storage_id": "string",
- "data": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "requested_in_gb": 0,
- "consumed_in_gb": 0,
- "consumed_in_percent": 0
}
]
}
]
}Get application restart message and timestamp.
| applicationId required | string <uuid> Application ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "datetime": "2019-08-24T14:15:22Z",
- "message": "string"
}
]
}| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "type": "MONGODB",
- "version": "10.1",
- "mode": "CONTAINER",
- "accessibility": "PRIVATE",
- "cpu": 1250,
- "memory": 1024,
- "storage": 10,
- "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "host": "string",
- "port": 5432,
- "maximum_cpu": 1250,
- "maximum_memory": 1024,
- "disk_encrypted": true
}
]
}| applicationId required | string <uuid> Application ID |
| targetDatabaseId required | string <uuid> Target database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "type": "MONGODB",
- "version": "10.1",
- "mode": "CONTAINER",
- "accessibility": "PRIVATE",
- "cpu": 1250,
- "memory": 1024,
- "storage": 10,
- "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "host": "string",
- "port": 5432,
- "maximum_cpu": 1250,
- "maximum_memory": 1024,
- "disk_encrypted": true
}| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "database": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}| applicationId required | string <uuid> Application ID |
| targetLogicalDatabaseId required | string <uuid> Target database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "database": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}This will list the last 1000 logs of the application
| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "id": "4aa76065-68b3-41ef-aa1d-46be67012bef",
- "created_at": "2022-04-19T15:36:12.024Z",
- "message": "string",
- "pod_name": "app-z4aa76065-57d84cbbdb-xcg8v",
- "application_commit_id": "2bfd61fe45946c74f318050b26210be486c43a39"
}
]
}Get application deployment restrictions
| applicationId required | string <uuid> Application ID |
{- "deployment_restrictions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "mode": "MATCH",
- "type": "PATH",
- "value": "application1/src/"
}
]
}Create an application deployment restriction
| applicationId required | string <uuid> Application ID |
| mode required | string (DeploymentRestrictionModeEnum) Enum: "EXCLUDE" "MATCH" Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated. |
| type required | string (DeploymentRestrictionTypeEnum) Value: "PATH" |
| value required | string For |
{- "mode": "MATCH",
- "type": "PATH",
- "value": "application1/src/"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "mode": "MATCH",
- "type": "PATH",
- "value": "application1/src/"
}Edit an application deployment restriction
| applicationId required | string <uuid> Application ID |
| deploymentRestrictionId required | string <uuid> Deployment Restriction ID |
| mode required | string (DeploymentRestrictionModeEnum) Enum: "EXCLUDE" "MATCH" Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated. |
| type required | string (DeploymentRestrictionTypeEnum) Value: "PATH" |
| value required | string For |
{- "mode": "MATCH",
- "type": "PATH",
- "value": "application1/src/"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "mode": "MATCH",
- "type": "PATH",
- "value": "application1/src/"
}By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter. You can also filter by status (FAILED or SUCCESS), and git_commit_id
| applicationId required | string <uuid> Application ID |
| startId | string <uuid> Starting point after which to return results |
{- "page": 1,
- "page_size": 20,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "commit": {
- "created_at": "2019-08-24T14:15:22Z",
- "git_commit_id": "string",
- "tag": "v2.1.1",
- "message": "string",
- "author_name": "string",
- "author_avatar_url": "string",
- "commit_page_url": "string"
}, - "status": "FAILED"
}
]
}| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}
]
}| applicationId required | string <uuid> Application ID |
| key required | string key is case sensitive |
| value required | string value of the env variable. |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}Import environment variables in a defined scope, with a defined visibility.
| applicationId required | string <uuid> Application ID |
| overwrite required | boolean Default: false |
required | Array of objects |
{- "overwrite": false,
- "vars": [
- {
- "name": "string",
- "value": "string",
- "scope": "APPLICATION",
- "is_secret": true
}
]
}{- "total_variables_to_import": 0,
- "successful_imported_variables": [
- {
- "name": "string",
- "value": "string",
- "scope": "APPLICATION",
- "is_secret": true
}
]
}| applicationId required | string <uuid> Application ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| applicationId required | string <uuid> Application ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| key required | string key is case sensitive |
| value required | string value of the env variable. |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| applicationId required | string <uuid> Application ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| value required | string |
{- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| applicationId required | string <uuid> Application ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| key required | string |
{- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}Secrets are like environment variables, but they are secured and can't be revealed.
| applicationId required | string <uuid> Application ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}
]
}| applicationId required | string <uuid> Application ID |
| key required | string key is case sensitive |
| value required | string value of the secret. Clear value will never be returned |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| applicationId required | string <uuid> Application ID |
| secretId required | string <uuid> Secret ID |
| applicationId required | string <uuid> Application ID |
| secretId required | string <uuid> Secret ID |
| value required | string |
| key required | string |
{- "value": "string",
- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| applicationId required | string <uuid> Application ID |
| secretId required | string <uuid> Secret ID |
| value required | string |
{- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| applicationId required | string <uuid> Application ID |
| secretId required | string <uuid> Secret ID |
| key required | string |
{- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter
| applicationId required | string <uuid> Application ID |
| startId | string <uuid> Starting point after which to return results |
{- "page": 1,
- "page_size": 20,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
}, - "commit": {
- "created_at": "2019-08-24T14:15:22Z",
- "git_commit_id": "string",
- "tag": "v2.1.1",
- "message": "string",
- "author_name": "string",
- "author_avatar_url": "string",
- "commit_page_url": "string"
}, - "status": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}, - "type": "string",
- "log": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}| containerId required | string <uuid> Container ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "registry": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}| containerId required | string <uuid> Container ID |
Array of objects | |
Array of objects | |
| name required | string name is case insensitive |
| registry_id required | string id of the linked registry |
| image_name required | string The image name pattern differs according to chosen container registry provider:
|
| tag required | string tag of the image container |
| arguments | Array of strings |
| entrypoint | string optional entrypoint when launching container |
| cpu | integer Default: 500 unit is millicores (m). 1000m = 1 cpu |
| memory | integer Default: 512 unit is MB. 1024 MB = 1GB |
| min_running_instances | integer >= 0 Default: 1 Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running. |
| max_running_instances | integer Default: 1 Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. |
| auto_preview | boolean Indicates if the 'environment preview option' is enabled for this container. |
{- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "ports": [
- {
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
], - "name": "string",
- "registry_id": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "registry": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}| containerId required | string <uuid> Container ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}This will return all the custom domains and Qovery autogenerated domain for the given container
| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "url": "string"
}
]
}You must provide a git commit id
| containerId required | string <uuid> Container ID |
| image_tag required | string Image tag to deploy |
{- "image_tag": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| containerId required | string <uuid> Container ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| containerId required | string <uuid> Container ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}Get list and values of the advanced settings of the container.
| containerId required | string <uuid> Container ID |
[- {
- "deployment.custom_domain_check_enabled": true,
- "network.ingress.proxy_body_size_mb": 100,
- "network.ingress.enable_cors": false,
- "network.ingress.cors_allow_origin": "*",
- "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
- "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
- "network.ingress.proxy_buffer_size_kb": 4,
- "network.ingress.keepalive_time_seconds": 3600,
- "network.ingress.keepalive_timeout_seconds": 60,
- "network.ingress.send_timeout_seconds": 60,
- "network.ingress.proxy_connect_timeout_seconds": 60,
- "network.ingress.proxy_send_timeout_seconds": 60,
- "network.ingress.proxy_read_timeout_seconds": 60,
- "network.ingress.whitelist_source_range": "0.0.0.0/0",
- "readiness_probe.type": "NONE",
- "readiness_probe.http_get.path": "/",
- "readiness_probe.initial_delay_seconds": 30,
- "readiness_probe.period_seconds": 10,
- "readiness_probe.timeout_seconds": 1,
- "readiness_probe.success_threshold": 1,
- "readiness_probe.failure_threshold": 3,
- "liveness_probe.type": "NONE",
- "liveness_probe.http_get.path": "/",
- "liveness_probe.initial_delay_seconds": 30,
- "liveness_probe.period_seconds": 10,
- "liveness_probe.timeout_seconds": 5,
- "liveness_probe.success_threshold": 1,
- "liveness_probe.failure_threshold": 3
}
]Edit advanced settings by returning table of advanced settings.
| containerId required | string <uuid> Container ID |
| deployment.custom_domain_check_enabled | boolean Default: true disable custom domain check when deploying an application |
| network.ingress.proxy_body_size_mb | integer Default: 100 |
| network.ingress.enable_cors | boolean Default: false |
| network.ingress.cors_allow_origin | string Default: "*" |
| network.ingress.cors_allow_methods | string Default: "GET, PUT, POST, DELETE, PATCH, OPTIONS" |
| network.ingress.cors_allow_headers | string Default: "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" |
| network.ingress.proxy_buffer_size_kb | integer Default: 4 header buffer size used while reading response header from upstream |
| network.ingress.keepalive_time_seconds | integer Default: 3600 Limits the maximum time (in seconds) during which requests can be processed through one keepalive connection |
| network.ingress.keepalive_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) during which an idle keepalive connection to an upstream server will stay open. |
| network.ingress.send_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for transmitting a response to the client |
| network.ingress.proxy_connect_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for establishing a connection to a proxied server |
| network.ingress.proxy_send_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for transmitting a request to the proxied server |
| network.ingress.proxy_read_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for reading a response from the proxied server |
| network.ingress.whitelist_source_range | string Default: "0.0.0.0/0" list of source ranges to allow access to ingress proxy. This property can be used to whitelist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 To allow all source ranges, set 0.0.0.0/0. |
| readiness_probe.type | string Default: "TCP" Enum: "NONE" "TCP" "HTTP"
|
| readiness_probe.http_get.path | string Default: "/" HTTP GET path to check status (must returns 2xx E.g "/healtz") - only usable with TYPE = HTTP |
| readiness_probe.initial_delay_seconds | integer Default: 30 Delay before liveness probe is initiated |
| readiness_probe.period_seconds | integer Default: 10 How often to perform the probe |
| readiness_probe.timeout_seconds | integer Default: 1 When the probe times out |
| readiness_probe.success_threshold | integer Default: 1 Minimum consecutive successes for the probe to be considered successful after having failed. |
| readiness_probe.failure_threshold | integer Default: 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. |
| liveness_probe.type | string Default: "TCP" Enum: "NONE" "TCP" "HTTP"
|
| liveness_probe.http_get.path | string Default: "/" HTTP GET path to check status (must returns 2xx E.g "/healtz") - only usable with TYPE = HTTP |
| liveness_probe.initial_delay_seconds | integer Default: 30 Delay before liveness probe is initiated |
| liveness_probe.period_seconds | integer Default: 10 How often to perform the probe |
| liveness_probe.timeout_seconds | integer Default: 5 When the probe times out |
| liveness_probe.success_threshold | integer Default: 1 Minimum consecutive successes for the probe to be considered successful after having failed. |
| liveness_probe.failure_threshold | integer Default: 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. |
[- {
- "deployment.custom_domain_check_enabled": true,
- "network.ingress.proxy_body_size_mb": 100,
- "network.ingress.enable_cors": false,
- "network.ingress.cors_allow_origin": "*",
- "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
- "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
- "network.ingress.proxy_buffer_size_kb": 4,
- "network.ingress.keepalive_time_seconds": 3600,
- "network.ingress.keepalive_timeout_seconds": 60,
- "network.ingress.send_timeout_seconds": 60,
- "network.ingress.proxy_connect_timeout_seconds": 60,
- "network.ingress.proxy_send_timeout_seconds": 60,
- "network.ingress.proxy_read_timeout_seconds": 60,
- "network.ingress.whitelist_source_range": "0.0.0.0/0",
- "readiness_probe.type": "NONE",
- "readiness_probe.http_get.path": "/",
- "readiness_probe.initial_delay_seconds": 30,
- "readiness_probe.period_seconds": 10,
- "readiness_probe.timeout_seconds": 1,
- "readiness_probe.success_threshold": 1,
- "readiness_probe.failure_threshold": 3,
- "liveness_probe.type": "NONE",
- "liveness_probe.http_get.path": "/",
- "liveness_probe.initial_delay_seconds": 30,
- "liveness_probe.period_seconds": 10,
- "liveness_probe.timeout_seconds": 5,
- "liveness_probe.success_threshold": 1,
- "liveness_probe.failure_threshold": 3
}
][- {
- "deployment.custom_domain_check_enabled": true,
- "network.ingress.proxy_body_size_mb": 100,
- "network.ingress.enable_cors": false,
- "network.ingress.cors_allow_origin": "*",
- "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
- "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
- "network.ingress.proxy_buffer_size_kb": 4,
- "network.ingress.keepalive_time_seconds": 3600,
- "network.ingress.keepalive_timeout_seconds": 60,
- "network.ingress.send_timeout_seconds": 60,
- "network.ingress.proxy_connect_timeout_seconds": 60,
- "network.ingress.proxy_send_timeout_seconds": 60,
- "network.ingress.proxy_read_timeout_seconds": 60,
- "network.ingress.whitelist_source_range": "0.0.0.0/0",
- "readiness_probe.type": "NONE",
- "readiness_probe.http_get.path": "/",
- "readiness_probe.initial_delay_seconds": 30,
- "readiness_probe.period_seconds": 10,
- "readiness_probe.timeout_seconds": 1,
- "readiness_probe.success_threshold": 1,
- "readiness_probe.failure_threshold": 3,
- "liveness_probe.type": "NONE",
- "liveness_probe.http_get.path": "/",
- "liveness_probe.initial_delay_seconds": 30,
- "liveness_probe.period_seconds": 10,
- "liveness_probe.timeout_seconds": 5,
- "liveness_probe.success_threshold": 1,
- "liveness_probe.failure_threshold": 3
}
]Edit the Network settings of the container.
| containerId required | string <uuid> Container ID |
| sticky_session | boolean Default: false Specify if the sticky session option (also called persistant session) is activated or not for this container. If activated, user will be redirected by the load balancer to the same instance each time he access to the container. |
{- "sticky_session": false
}{- "sticky_session": false
}| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "domain": "my.domain.tld",
- "validation_domain": "string",
- "status": "VALIDATION_PENDING"
}
]
}Add a custom domain to this container in order not to use qovery autogenerated domain
| containerId required | string <uuid> Container ID |
| domain required | string your custom domain |
{- "domain": "my.domain.tld"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "domain": "my.domain.tld",
- "validation_domain": "string",
- "status": "VALIDATION_PENDING"
}To edit a Custom Domain you must have the project user permission
| containerId required | string <uuid> Container ID |
| customDomainId required | string <uuid> Custom Domain ID |
| domain required | string your custom domain |
{- "domain": "my.domain.tld"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "domain": "my.domain.tld",
- "validation_domain": "string",
- "status": "VALIDATION_PENDING"
}| containerId required | string <uuid> Container ID |
| customDomainId required | string <uuid> Custom Domain ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "domain": "my.domain.tld",
- "validation_domain": "string",
- "status": "VALIDATION_PENDING"
}| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "registry": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}
]
}Add container dependency to this container to prevent this container starting before the linked dependencies
| containerId required | string <uuid> Container ID |
| targetContainerId required | string <uuid> Target container ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "registry": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "name": "instance 1",
- "cpu": {
- "requested_in_float": 0,
- "consumed_in_number": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}, - "memory": {
- "requested_in_mb": 0,
- "consumed_in_mb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}
}
]
}| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "storage_id": "string",
- "requested_in_gb": 0,
- "consumed_in_gb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}
]
}Returns min, max, and running number of instances of the application
| containerId required | string <uuid> Container ID |
{- "min": 0,
- "max": 0,
- "running": 0,
- "running_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert",
- "updated_at": "2019-08-24T14:15:22Z"
}| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "database": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}| containerId required | string <uuid> Container ID |
| targetLogicalDatabaseId required | string <uuid> Target database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "database": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}This will list the last 1000 logs of the container
| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "id": "4aa76065-68b3-41ef-aa1d-46be67012bef",
- "created_at": "2022-04-19T15:36:12.024Z",
- "message": "string",
- "pod_name": "app-z4aa76065-57d84cbbdb-xcg8v",
- "application_commit_id": "2bfd61fe45946c74f318050b26210be486c43a39"
}
]
}Returns the 20 last container deployments
| containerId required | string <uuid> Container ID |
{- "page": 1,
- "page_size": 20,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "FAILED",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string"
}
]
}| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}
]
}| containerId required | string <uuid> Container ID |
| key required | string key is case sensitive |
| value required | string value of the env variable. |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}Import environment variables in a defined scope, with a defined visibility.
| containerId required | string <uuid> Container ID |
| overwrite required | boolean Default: false |
required | Array of objects |
{- "overwrite": false,
- "vars": [
- {
- "name": "string",
- "value": "string",
- "scope": "APPLICATION",
- "is_secret": true
}
]
}{- "total_variables_to_import": 0,
- "successful_imported_variables": [
- {
- "name": "string",
- "value": "string",
- "scope": "APPLICATION",
- "is_secret": true
}
]
}| containerId required | string <uuid> Container ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| containerId required | string <uuid> Container ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| key required | string key is case sensitive |
| value required | string value of the env variable. |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| containerId required | string <uuid> Container ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| value required | string |
{- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| containerId required | string <uuid> Container ID |
| environmentVariableId required | string <uuid> Environment Variable ID |
| key required | string |
{- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "value": "string",
- "overridden_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "value": "string",
- "scope": "APPLICATION"
}, - "aliased_variable": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "value": "string",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}Secrets are like environment variables, but they are secured and can't be revealed.
| containerId required | string <uuid> Container ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}
]
}| containerId required | string <uuid> Container ID |
| key required | string key is case sensitive |
| value required | string value of the secret. Clear value will never be returned |
{- "key": "string",
- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| containerId required | string <uuid> Container ID |
| secretId required | string <uuid> Secret ID |
| containerId required | string <uuid> Container ID |
| secretId required | string <uuid> Secret ID |
| value required | string |
| key required | string |
{- "value": "string",
- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| containerId required | string <uuid> Container ID |
| secretId required | string <uuid> Secret ID |
| value required | string |
{- "value": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| containerId required | string <uuid> Container ID |
| secretId required | string <uuid> Secret ID |
| key required | string |
{- "key": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "key": "string",
- "overridden_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "scope": "APPLICATION"
}, - "aliased_secret": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "QOVERY_DATABASE_PSQL_NAME",
- "scope": "APPLICATION"
}, - "scope": "APPLICATION",
- "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
- "service_name": "string",
- "service_type": "APPLICATION"
}| databaseId required | string <uuid> Database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "type": "MONGODB",
- "version": "10.1",
- "mode": "CONTAINER",
- "accessibility": "PRIVATE",
- "cpu": 1250,
- "memory": 1024,
- "storage": 10,
- "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "host": "string",
- "port": 5432,
- "maximum_cpu": 1250,
- "maximum_memory": 1024,
- "disk_encrypted": true
}To edit a database you must have the admin permission
| databaseId required | string <uuid> Database ID |
| name | string name is case-insensitive |
| version | string |
| accessibility | string (DatabaseAccessibilityEnum) Default: "PRIVATE" Enum: "PRIVATE" "PUBLIC" |
| cpu | integer Default: 250 unit is millicores (m). 1000m = 1 cpu |
| memory | integer unit is MB. 1024 MB = 1GB
|
| storage | integer unit is GB |
{- "name": "string",
- "version": "10.1",
- "accessibility": "PRIVATE",
- "cpu": 1250,
- "memory": 1024,
- "storage": 4
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "type": "MONGODB",
- "version": "10.1",
- "mode": "CONTAINER",
- "accessibility": "PRIVATE",
- "cpu": 1250,
- "memory": 1024,
- "storage": 10,
- "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "host": "string",
- "port": 5432,
- "maximum_cpu": 1250,
- "maximum_memory": 1024,
- "disk_encrypted": true
}| databaseId required | string <uuid> Database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| databaseId required | string <uuid> Database ID |
| login required | string |
| password required | string |
{- "login": "string",
- "password": "string"
}{- "host": "string",
- "port": 0,
- "login": "string",
- "password": "string"
}| databaseId required | string <uuid> Database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| databaseId required | string <uuid> Database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| databaseId required | string <uuid> Database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}| databaseId required | string <uuid> Database ID |
{- "cpu": {
- "requested_in_float": 0,
- "consumed_in_number": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}, - "memory": {
- "requested_in_mb": 0,
- "consumed_in_mb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}, - "storage": {
- "requested_in_gb": 0,
- "consumed_in_gb": 0,
- "consumed_in_percent": 0,
- "warning_threshold_in_percent": 0,
- "alert_threshold_in_percent": 0,
- "status": "Alert"
}
}| databaseId required | string <uuid> Database ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "requested_in_number": 0,
- "consumed_in_number": 0,
- "consumed_in_percent": 0
}
]
}| databaseId required | string <uuid> Database ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "requested_in_mb": 0,
- "consumed_in_mb": 0,
- "consumed_in_percent": 0
}
]
}| databaseId required | string <uuid> Database ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "requested_in_gb": 0,
- "consumed_in_gb": 0,
- "consumed_in_percent": 0
}
]
}The value returned corresponds to the 95th centile
| databaseId required | string <uuid> Database ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "instance_name": "instance 1",
- "data": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "value": 0
}
]
}
]
}Get database restart message and timestamp.
| databaseId required | string <uuid> Database ID |
| lastSeconds required | number Up to how many seconds in the past to ask analytics results |
{- "results": [
- {
- "datetime": "2019-08-24T14:15:22Z",
- "message": "string"
}
]
}By default it returns the 20 last results. The response is paginated.
| databaseId required | string <uuid> Database ID |
| startId | string <uuid> Starting point after which to return results |
{- "page": 1,
- "page_size": 20,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "FAILED"
}
]
}A logical database exists inside a database. The database is a service that exists within an environment, that you can deploy, and that has allocated resources. A database can have several logical databases
| databaseId required | string <uuid> Database ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "database": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}If you don't specify credentials, Qovery will autogenerate them.
| databaseId required | string <uuid> Database ID |
| name required | string name is case insensitive |
| description | string |
{- "name": "string",
- "description": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "database": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}A logical database exists inside a database. The database is a service that exists within an environment, that you can deploy, and that has allocated resources. A database can have several logical databases
| logicalDatabaseId required | string <uuid> Logical Database ID |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "database": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}| logicalDatabaseId required | string <uuid> Logical Database ID |
| name required | string name is case insensitive |
| description | string |
{- "name": "string",
- "description": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "description": "string",
- "database": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}| logicalDatabaseId required | string <uuid> Logical Database ID |
| login required | string |
| password required | string |
{- "login": "string",
- "password": "string"
}{- "host": "string",
- "port": 0,
- "login": "string",
- "password": "string"
}| logicalDatabaseId required | string <uuid> Logical Database ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "git_repository": {
- "has_access": true,
- "provider": "BITBUCKET",
- "owner": "John Doe",
- "name": "simple-node-app",
- "branch": "string",
- "root_path": "string",
- "deployed_commit_id": "string",
- "deployed_commit_date": "2019-08-24T14:15:22Z",
- "deployed_commit_contributor": "4156f3f4-0b43-4670-b2ef-cd6803200694",
- "deployed_commit_tag": "v1.0.1"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "description": "string",
- "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}
]
}| logicalDatabaseId required | string <uuid> Logical Database ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "registry": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "image_name": "string",
- "tag": "string",
- "arguments": [
- "string"
], - "entrypoint": "string",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}
]
}| databaseId required | string <uuid> Database ID |
{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "storage": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FAST_SSD",
- "size": 16,
- "mount_point": "/mnt/images"
}
], - "environment": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "git_repository": {
- "has_access": true,
- "provider": "BITBUCKET",
- "owner": "John Doe",
- "name": "simple-node-app",
- "branch": "string",
- "root_path": "string",
- "deployed_commit_id": "string",
- "deployed_commit_date": "2019-08-24T14:15:22Z",
- "deployed_commit_contributor": "4156f3f4-0b43-4670-b2ef-cd6803200694",
- "deployed_commit_tag": "v1.0.1"
}, - "maximum_cpu": 16000,
- "maximum_memory": 16384,
- "name": "string",
- "description": "string",
- "build_mode": "BUILDPACKS",
- "dockerfile_path": "string",
- "buildpack_language": "CLOJURE",
- "cpu": 1250,
- "memory": 1024,
- "min_running_instances": 1,
- "max_running_instances": 1,
- "healthcheck": {
- "protocol": "TCP",
- "value": "string"
}, - "auto_preview": true,
- "ports": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "internal_port": 8080,
- "external_port": 8080,
- "publicly_accessible": true,
- "is_default": true,
- "protocol": "HTTP"
}
]
}
]
}By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter
| databaseId required | string <uuid> Database ID |
| startId | string <uuid> Starting point after which to return results |
{- "page": 1,
- "page_size": 20,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "message": "string",
- "status": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}
}
]
}| databaseId required | string <uuid> Database ID |
| name required | string |
| message required | string |
{- "name": "string",
- "message": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "message": "string",
- "status": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}
}By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter
| databaseId required | string <uuid> Database ID |
| startId | string <uuid> Starting point after which to return results |
{- "page": 1,
- "page_size": 20,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
}, - "commit": {
- "created_at": "2019-08-24T14:15:22Z",
- "git_commit_id": "string",
- "tag": "v2.1.1",
- "message": "string",
- "author_name": "string",
- "author_avatar_url": "string",
- "commit_page_url": "string"
}, - "status": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "state": "BUILDING",
- "message": "string",
- "service_deployment_status": "NEVER_DEPLOYED",
- "last_deployment_date": "2019-08-24T14:15:22Z"
}, - "type": "string",
- "log": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}{- "results": [
- {
- "id": "string",
- "name": "simple-node-app",
- "default_branch": "master",
- "is_private": true
}
]
}{- "results": [
- {
- "id": "string",
- "name": "simple-node-app",
- "default_branch": "master",
- "is_private": true
}
]
}{- "results": [
- {
- "id": "string",
- "name": "simple-node-app",
- "default_branch": "master",
- "is_private": true
}
]
}{- "total_invited": 2,
}{- "results": [
- {
- "id": "string",
- "name": "simple-node-app",
- "default_branch": "master",
- "is_private": true
}
]
}{- "results": [
- {
- "id": "string",
- "name": "simple-node-app",
- "default_branch": "master",
- "is_private": true
}
]
}{- "results": [
- {
- "id": "string",
- "name": "simple-node-app",
- "default_branch": "master",
- "is_private": true
}
]
}Retrieve the Sign Up information of the user
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "user_email": "string",
- "type_of_use": "PERSONAL",
- "qovery_usage": "string",
- "company_name": "string",
- "company_size": "1-10",
- "user_role": "string",
- "qovery_usage_other": "string",
- "user_questions": "string",
- "current_step": "string",
- "dx_auth": true
}Send a Sign Up request containing the user information
| first_name required | string |
| last_name required | string |
| user_email required | string |
| type_of_use required | string (TypeOfUseEnum) Enum: "PERSONAL" "SCHOOL" "WORK" |
| qovery_usage required | string |
| company_name | string or null |
| company_size | string (CompanySizeEnum) Enum: "1-10" "11-50" "51-200" "201-500" "500+" |
| user_role | string or null |
| qovery_usage_other | string or null |
| user_questions | string or null |
| current_step | string or null |
| dx_auth | boolean or null |
{- "first_name": "string",
- "last_name": "string",
- "user_email": "string",
- "type_of_use": "PERSONAL",
- "qovery_usage": "string",
- "company_name": "string",
- "company_size": "1-10",
- "user_role": "string",
- "qovery_usage_other": "string",
- "user_questions": "string",
- "current_step": "string",
- "dx_auth": true
}